/*
 * Copyright 2004-2006, Thorbjrn Lindeijer <thorbjorn@lindeijer.nl>
 * Copyright 2004-2006, Adam Turk <aturk@biggeruniverse.com>
 *
 * This file is part of libtiled-java.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package tiled.util;

import java.awt.Dimension;
import java.awt.Image;
import java.awt.image.BufferedImage;

/**
 * Cuts tiles from a tileset image according to a regular rectangular pattern. Supports a variable spacing between tiles
 * and a margin around them.
 */
public class BasicTileCutter implements TileCutter {
	private int				nextX, nextY;
	private BufferedImage	image;
	private final int		tileWidth;
	private final int		tileHeight;
	private final int		tileSpacing;
	private final int		tileMargin;

	public BasicTileCutter(int tileWidth, int tileHeight, int tileSpacing, int tileMargin) {
		this.tileWidth = tileWidth;
		this.tileHeight = tileHeight;
		this.tileSpacing = tileSpacing;
		this.tileMargin = tileMargin;

		this.reset();
	}

	@Override
	public String getName() {
		return "Basic";
	}

	@Override
	public void setImage(BufferedImage image) {
		this.image = image;
	}

	@Override
	public Image getNextTile() {
		if ((this.nextY + this.tileHeight + this.tileMargin) <= this.image.getHeight()) {
			BufferedImage tile = this.image.getSubimage(this.nextX, this.nextY, this.tileWidth, this.tileHeight);
			this.nextX += this.tileWidth + this.tileSpacing;

			if ((this.nextX + this.tileWidth + this.tileMargin) > this.image.getWidth()) {
				this.nextX = this.tileMargin;
				this.nextY += this.tileHeight + this.tileSpacing;
			}

			return tile;
		}

		return null;
	}

	@Override
	public void reset() {
		this.nextX = this.tileMargin;
		this.nextY = this.tileMargin;
	}

	@Override
	public Dimension getTileDimensions() {
		return new Dimension(this.tileWidth, this.tileHeight);
	}

	/**
	 * Returns the spacing between tile images.
	 * 
	 * @return the spacing between tile images.
	 */
	public int getTileSpacing() {
		return this.tileSpacing;
	}

	/**
	 * Returns the margin around the tile images.
	 * 
	 * @return the margin around the tile images.
	 */
	public int getTileMargin() {
		return this.tileMargin;
	}

	/**
	 * Returns the number of tiles per row in the tileset image.
	 * 
	 * @return the number of tiles per row in the tileset image.
	 */
	public int getTilesPerRow() {
		return ((this.image.getWidth() - (2 * this.tileMargin)) + this.tileSpacing) / (this.tileWidth + this.tileSpacing);
	}
}
